package gsar.client;

/*
Copyright (c) 2009, Eric Eaton, University of Maryland Baltimore County
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the University of Maryland Baltimore County nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


/** Describes an action
 * @author Eric Eaton
 */
public class GWAction {
	/** the name of the action */
	private String m_name = null;
	
	/** the direction of the action, if any */
	private GWDirection m_direction = null;
	
	/** Constructor for an action without a direction.
	 * @param name the name of the action
	 */
	public GWAction(String name) {
		if (name == null || name.length() == 0) {
			throw new IllegalArgumentException("name cannot be null or empty.");
		}
		m_name = name;
	}
	
	/** Constructor for an action with a direction.
	 * @param name the name of the action
	 * @param direction the direction of an action, which should be the string
	 *        representation of a GWDirection value.
	 */
	public GWAction(String name, String direction) {
		this(name);
		if (direction != null)
			m_direction = GWDirection.valueOf(direction);
	}
	
	
	/** Constructor for an action with a direction.
	 * @param name the name of the action
	 * @param direction the direction of the action
	 */
	public GWAction(String name, GWDirection direction) {
		this(name);
		m_direction = direction;
	}
	
	/** Gets the name of the action.
	 * @return the name of the action.
	 */
	public String getName() { return m_name; }
	
	/** Gets the direction of the action, if any.
	 * @return the direction of the action, if any.
	 */
	public GWDirection getDirection() { return m_direction; }
	
	public String toString() {
		String str = m_name;
		if (m_direction != null) {
			str += "_"+m_direction;
		}
		return str;
	}
}
